﻿using System;

namespace YourLastOptionsDialog.Core.Attributes
{
    /// <summary>
    /// An option attribute that represents a boolean option.
    /// </summary>
    [AttributeUsage(AttributeTargets.Property)]
    public sealed class OptionBooleanAttribute : OptionAttribute
    {
        /// <summary>
        /// Gets or sets a value indicating whether the user must confirm activation of this value (i.e. changing the value from <c>false</c> to <c>true</c>).
        /// </summary>
        /// <value>
        /// <c>true</c> if the user must confirm activation; otherwise, <c>false</c>.
        /// </value>
        public bool UserMustConfirmActivation
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets a value indicating whether the user must confirm deactivation of this value (i.e. changing the value from <c>true</c> to <c>false</c>).
        /// </summary>
        /// <value>
        /// <c>true</c> if the user must confirm deactivation; otherwise, <c>false</c>.
        /// </value>
        public bool UserMustConfirmDeactivation
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets the activation prompt. This is only used if <see cref="UserMustConfirmActivation"/> is set to true.
        /// If a <see cref="OptionAttribute.ResourceType"/> is set in the base class, this should contain the key to the localized entry in the resources.
        /// </summary>
        public string ActivationPrompt
        {
            get;
            set;
        }

        /// <summary>
        /// Gets or sets the deactivation prompt. This is only used if <see cref="UserMustConfirmDeactivation"/> is set to true.
        /// If a <see cref="OptionAttribute.ResourceType"/> is set in the base class, this should contain the key to the localized entry in the resources.
        /// </summary>
        public string DeactivationPrompt
        {
            get;
            set;
        }
    }
}